Skip to content

Conversation

TomNicholas
Copy link
Member

@TomNicholas TomNicholas commented Oct 9, 2024

The bullets here need to be fleshed out, but I think this is the list of changes we have made... I will amend this to link to relevant parts of the main documentation as they are merged, instead of repeating long-form text and examples here.

The logic for making this a markdown doc in the main repo is:

  • It definitely shouldn't go in the xarray-contrib/datatree repo because we're about to archive that, and we may want to make changes to this doc,
  • It arguably shouldn't go in the main xarray docs because it's only relevant to people who used the old xarray-contrib/datatree repo - no user coming from the main docs needs to be able to find this,
  • This can easily be linked to from the old repo / the main xarray docs / what's new.

If others think this should just go somewhere in the main docs then I can do that instead though.

cc @eni-awowale @owenlittlejohns @flamingbear @keewis @aladinor @shoyer

@TomNicholas TomNicholas added topic-documentation topic-DataTree Related to the implementation of a DataTree class labels Oct 9, 2024
@TomNicholas TomNicholas mentioned this pull request Oct 9, 2024
27 tasks
@TomNicholas TomNicholas marked this pull request as ready for review October 15, 2024 00:14
@TomNicholas
Copy link
Member Author

I think this is ready, in case anyone has any comments (including any previous users of xarray-contrib/datatree - @jhamman ?)

Copy link
Member

@flamingbear flamingbear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of these are just suggestions, it looks good to me.

@TomNicholas TomNicholas enabled auto-merge (squash) October 15, 2024 14:14
@eni-awowale
Copy link
Collaborator

This looks good @TomNicholas! I initially thought this would live in the main xarray docs. I thought @keewis mentioned adding a sub-section to whats-new.rst? Nbd though it also works here!

@TomNicholas
Copy link
Member Author

My recollection was that @keewis suggested merely linking to this file from the what's new, but I think either is fine.

@TomNicholas TomNicholas merged commit 97799e8 into pydata:main Oct 15, 2024
28 checks passed
@TomNicholas TomNicholas deleted the datatree_migration_guide branch October 15, 2024 18:44
dcherian added a commit to TomAugspurger/xarray that referenced this pull request Oct 21, 2024
* main:
  Fix multiple grouping with missing groups (pydata#9650)
  flox: Properly propagate multiindex (pydata#9649)
  Update Datatree html repr to indicate inheritance (pydata#9633)
  Re-implement map_over_datasets using group_subtrees (pydata#9636)
  fix zarr intersphinx (pydata#9652)
  Replace black and blackdoc with ruff-format (pydata#9506)
  Fix error and missing code cell in io.rst (pydata#9641)
  Support alternative names for the root node in DataTree.from_dict (pydata#9638)
  Updates to DataTree.equals and DataTree.identical (pydata#9627)
  DOC: Clarify error message in open_dataarray (pydata#9637)
  Add zip_subtrees for paired iteration over DataTrees (pydata#9623)
  Type check datatree tests (pydata#9632)
  Add missing `memo` argument to DataTree.__deepcopy__ (pydata#9631)
  Bug fixes for DataTree indexing and aggregation (pydata#9626)
  Add inherit=False option to DataTree.copy() (pydata#9628)
  docs(groupby): mention deprecation of `squeeze` kwarg (pydata#9625)
  Migration guide for users of old datatree repo (pydata#9598)
  Reimplement Datatree typed ops (pydata#9619)
dcherian added a commit to dcherian/xarray that referenced this pull request Oct 22, 2024
* main: (63 commits)
  Add close() method to DataTree and use it to clean-up open files in tests (pydata#9651)
  Change URL for pydap test (pydata#9655)
  Fix multiple grouping with missing groups (pydata#9650)
  flox: Properly propagate multiindex (pydata#9649)
  Update Datatree html repr to indicate inheritance (pydata#9633)
  Re-implement map_over_datasets using group_subtrees (pydata#9636)
  fix zarr intersphinx (pydata#9652)
  Replace black and blackdoc with ruff-format (pydata#9506)
  Fix error and missing code cell in io.rst (pydata#9641)
  Support alternative names for the root node in DataTree.from_dict (pydata#9638)
  Updates to DataTree.equals and DataTree.identical (pydata#9627)
  DOC: Clarify error message in open_dataarray (pydata#9637)
  Add zip_subtrees for paired iteration over DataTrees (pydata#9623)
  Type check datatree tests (pydata#9632)
  Add missing `memo` argument to DataTree.__deepcopy__ (pydata#9631)
  Bug fixes for DataTree indexing and aggregation (pydata#9626)
  Add inherit=False option to DataTree.copy() (pydata#9628)
  docs(groupby): mention deprecation of `squeeze` kwarg (pydata#9625)
  Migration guide for users of old datatree repo (pydata#9598)
  Reimplement Datatree typed ops (pydata#9619)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic-DataTree Related to the implementation of a DataTree class topic-documentation
Projects
Development

Successfully merging this pull request may close these issues.

Migration guide for old users of xarray-contrib/datatree
3 participants